iconview: Add a summary
authorMatthias Clasen <mclasen@redhat.com>
Tue, 2 Mar 2021 03:47:38 +0000 (22:47 -0500)
committerEmmanuele Bassi <ebassi@gnome.org>
Thu, 11 Mar 2021 16:37:37 +0000 (16:37 +0000)
gtk/gtkiconview.c
gtk/gtkiconview.h

index cce12cc45de6954212db12ced5b4edc316eb2b72..1d7cb97fcf147acab4ef531982c83b81c29eb5f6 100644 (file)
 #include <string.h>
 
 /**
- * SECTION:gtkiconview
- * @title: GtkIconView
- * @short_description: A widget which displays a list of icons in a grid
+ * GtkIconView:
  *
- * #GtkIconView provides an alternative view on a #GtkTreeModel.
+ * `GtkIconView` is a widget which displays data in a grid of icons.
+ *
+ * `GtkIconView` provides an alternative view on a `GtkTreeModel`.
  * It displays the model as a grid of icons with labels. Like
- * #GtkTreeView, it allows to select one or multiple items
- * (depending on the selection mode, see gtk_icon_view_set_selection_mode()).
- * In addition to selection with the arrow keys, #GtkIconView supports
+ * [class@Gtk.TreeView], it allows to select one or multiple items
+ * (depending on the selection mode, see [method@Gtk.IconView.set_selection_mode]).
+ * In addition to selection with the arrow keys, `GtkIconView` supports
  * rubberband selection, which is controlled by dragging the pointer.
  *
  * Note that if the tree model is backed by an actual tree store (as
  *
  * # CSS nodes
  *
- * |[<!-- language="plain" -->
+ * ```
  * iconview.view
  * ╰── [rubberband]
- * ]|
+ * ```
  *
- * GtkIconView has a single CSS node with name iconview and style class .view.
+ * `GtkIconView` has a single CSS node with name iconview and style class .view.
  * For rubberband selection, a subnode with name rubberband is used.
  */
 
index 7a204b54d9710cc3029364858416b694759c2bfc..3bdf57f0c81b28a9f688e7637d76a49dcbf4f394 100644 (file)
@@ -43,7 +43,9 @@ typedef struct _GtkIconView           GtkIconView;
  * @data: (closure): user data
  *
  * A function used by gtk_icon_view_selected_foreach() to map all
- * selected rows.  It will be called on every selected row in the view.
+ * selected rows.
+ *
+ * It will be called on every selected row in the view.
  */
 typedef void (* GtkIconViewForeachFunc)     (GtkIconView      *icon_view,
                                              GtkTreePath      *path,